-
-
Notifications
You must be signed in to change notification settings - Fork 21
chore: introduce prettier
#274
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR introduces Prettier to the eslint-github-bot repository for consistent code formatting. The configuration follows the standard setup used across ESLint organization repositories (markdown, css, json, rewrite), using tabs with 4-space width and avoiding arrow function parentheses.
Changes:
- Added Prettier with configuration matching ESLint org conventions (tabs, tabWidth: 4, arrowParens: avoid)
- Reformatted all JavaScript, YAML, and Markdown files according to Prettier rules
- Integrated Prettier into CI workflow with a new format check job and pre-commit hooks via lint-staged
Reviewed changes
Copilot reviewed 27 out of 29 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| prettier.config.js | New Prettier configuration following ESLint org conventions |
| .prettierignore | Excludes coverage directory from formatting |
| package.json | Adds Prettier dependency, fmt/fmt:check scripts, and lint-staged configuration |
| package-lock.json | Lockfile update for Prettier 3.8.1 dependency |
| .github/workflows/ci.yml | Adds new format check job to CI pipeline |
| .github/workflows/deploy.yml | Reformatted YAML with consistent indentation |
| eslint.config.js | Reformatted with tabs and Prettier rules |
| README.md | Reformatted list bullets from * to - |
| CONTRIBUTING.md | Reformatted list bullets from * to - |
| .github/copilot-instructions.md | Reformatted with consistent spacing and indentation |
| src/app.js | Reformatted with tabs (indentation only) |
| src/plugins/**/*.js | Reformatted with tabs, consistent spacing (no logic changes) |
| tests/**/*.test.js | Reformatted with tabs, consistent spacing (no logic changes) |
| tests/__mocks__/probot-scheduler.js | Reformatted function spacing |
Prerequisites checklist
What is the purpose of this pull request?
In this PR, I've added Prettier to keep formatting consistent.
The
prettier.config.jsfile follows the common setup used across the ESLint organization:I plan to add a
.git-blame-ignore-revsfile if preserving a clean git blame history is important.What changes did you make? (Give an overview)
In this PR, I've added Prettier to keep formatting consistent.
Related Issues
Ref: eslint/js#671
Is there anything you'd like reviewers to focus on?
N/A